<HTML>
<BODY BGCOLOR="white">
<PRE>
<FONT color="green">001</FONT>    package org.hackystat.sensor.ant.pmd;<a name="line.1"></a>
<FONT color="green">002</FONT>    <a name="line.2"></a>
<FONT color="green">003</FONT>    import java.io.File;<a name="line.3"></a>
<FONT color="green">004</FONT>    import java.util.ArrayList;<a name="line.4"></a>
<FONT color="green">005</FONT>    import java.util.Date;<a name="line.5"></a>
<FONT color="green">006</FONT>    import java.util.HashMap;<a name="line.6"></a>
<FONT color="green">007</FONT>    import java.util.HashSet;<a name="line.7"></a>
<FONT color="green">008</FONT>    import java.util.List;<a name="line.8"></a>
<FONT color="green">009</FONT>    import java.util.Map;<a name="line.9"></a>
<FONT color="green">010</FONT>    import java.util.Set;<a name="line.10"></a>
<FONT color="green">011</FONT>    import java.util.Map.Entry;<a name="line.11"></a>
<FONT color="green">012</FONT>    <a name="line.12"></a>
<FONT color="green">013</FONT>    import javax.xml.bind.JAXBContext;<a name="line.13"></a>
<FONT color="green">014</FONT>    import javax.xml.bind.JAXBException;<a name="line.14"></a>
<FONT color="green">015</FONT>    import javax.xml.bind.Unmarshaller;<a name="line.15"></a>
<FONT color="green">016</FONT>    import javax.xml.datatype.XMLGregorianCalendar;<a name="line.16"></a>
<FONT color="green">017</FONT>    <a name="line.17"></a>
<FONT color="green">018</FONT>    import org.apache.tools.ant.BuildException;<a name="line.18"></a>
<FONT color="green">019</FONT>    import org.hackystat.sensor.ant.pmd.jaxb.ObjectFactory;<a name="line.19"></a>
<FONT color="green">020</FONT>    import org.hackystat.sensor.ant.pmd.jaxb.Pmd;<a name="line.20"></a>
<FONT color="green">021</FONT>    import org.hackystat.sensor.ant.pmd.jaxb.Violation;<a name="line.21"></a>
<FONT color="green">022</FONT>    import org.hackystat.sensor.ant.task.HackystatSensorTask;<a name="line.22"></a>
<FONT color="green">023</FONT>    import org.hackystat.sensor.ant.util.LongTimeConverter;<a name="line.23"></a>
<FONT color="green">024</FONT>    import org.hackystat.sensorshell.SensorShellException;<a name="line.24"></a>
<FONT color="green">025</FONT>    <a name="line.25"></a>
<FONT color="green">026</FONT>    /**<a name="line.26"></a>
<FONT color="green">027</FONT>     * Implements an Ant task that parses the XML files generated by PMD Ant Task and sends the<a name="line.27"></a>
<FONT color="green">028</FONT>     * CodeIssue data to a Hackystat server.<a name="line.28"></a>
<FONT color="green">029</FONT>     * <a name="line.29"></a>
<FONT color="green">030</FONT>     * @author Aaron A. Kagawa, Julie Ann Sakuda, Philip Johnson<a name="line.30"></a>
<FONT color="green">031</FONT>     */<a name="line.31"></a>
<FONT color="green">032</FONT>    public class PmdSensor extends HackystatSensorTask {<a name="line.32"></a>
<FONT color="green">033</FONT>    <a name="line.33"></a>
<FONT color="green">034</FONT>      /** Prefix for type attributes. */<a name="line.34"></a>
<FONT color="green">035</FONT>      private static final String TYPE = "Type_";<a name="line.35"></a>
<FONT color="green">036</FONT>    <a name="line.36"></a>
<FONT color="green">037</FONT>      /** Tool in UserMap to use. */<a name="line.37"></a>
<FONT color="green">038</FONT>      private static String tool = "PMD";<a name="line.38"></a>
<FONT color="green">039</FONT>    <a name="line.39"></a>
<FONT color="green">040</FONT>      /** Initialize a new instance of a PmdSensor. */<a name="line.40"></a>
<FONT color="green">041</FONT>      public PmdSensor() {<a name="line.41"></a>
<FONT color="green">042</FONT>        super(tool);<a name="line.42"></a>
<FONT color="green">043</FONT>      }<a name="line.43"></a>
<FONT color="green">044</FONT>    <a name="line.44"></a>
<FONT color="green">045</FONT>      /**<a name="line.45"></a>
<FONT color="green">046</FONT>       * Initialize a new instance of a PmdSensor, passing the host email, and password directly. This<a name="line.46"></a>
<FONT color="green">047</FONT>       * supports testing.<a name="line.47"></a>
<FONT color="green">048</FONT>       * <a name="line.48"></a>
<FONT color="green">049</FONT>       * @param host The hackystat host URL.<a name="line.49"></a>
<FONT color="green">050</FONT>       * @param email The Hackystat email to use.<a name="line.50"></a>
<FONT color="green">051</FONT>       * @param password The Hackystat password to use.<a name="line.51"></a>
<FONT color="green">052</FONT>       */<a name="line.52"></a>
<FONT color="green">053</FONT>      public PmdSensor(String host, String email, String password) {<a name="line.53"></a>
<FONT color="green">054</FONT>        super(host, email, password, tool);<a name="line.54"></a>
<FONT color="green">055</FONT>      }<a name="line.55"></a>
<FONT color="green">056</FONT>    <a name="line.56"></a>
<FONT color="green">057</FONT>      /**<a name="line.57"></a>
<FONT color="green">058</FONT>       * Parses the PMD XML files and sends the resulting code issue results to the hackystat server.<a name="line.58"></a>
<FONT color="green">059</FONT>       * This method is invoked automatically by Ant.<a name="line.59"></a>
<FONT color="green">060</FONT>       * <a name="line.60"></a>
<FONT color="green">061</FONT>       * @throws BuildException If there is an error.<a name="line.61"></a>
<FONT color="green">062</FONT>       */<a name="line.62"></a>
<FONT color="green">063</FONT>      @Override<a name="line.63"></a>
<FONT color="green">064</FONT>      public void executeInternal() throws BuildException {<a name="line.64"></a>
<FONT color="green">065</FONT>        setupSensorShell();<a name="line.65"></a>
<FONT color="green">066</FONT>        int numberOfCodeIssues = 0;<a name="line.66"></a>
<FONT color="green">067</FONT>        Date startTime = new Date();<a name="line.67"></a>
<FONT color="green">068</FONT>    <a name="line.68"></a>
<FONT color="green">069</FONT>        // Iterate though each file, extract the PMD data, send to sensorshell.<a name="line.69"></a>
<FONT color="green">070</FONT>        for (File dataFile : getDataFiles()) {<a name="line.70"></a>
<FONT color="green">071</FONT>          verboseInfo("Processing file: " + dataFile);<a name="line.71"></a>
<FONT color="green">072</FONT>          try {<a name="line.72"></a>
<FONT color="green">073</FONT>            numberOfCodeIssues += processPmdXmlFile(dataFile);<a name="line.73"></a>
<FONT color="green">074</FONT>          }<a name="line.74"></a>
<FONT color="green">075</FONT>          catch (Exception e) {<a name="line.75"></a>
<FONT color="green">076</FONT>            signalError("Failure processing: " + dataFile, e);<a name="line.76"></a>
<FONT color="green">077</FONT>          }<a name="line.77"></a>
<FONT color="green">078</FONT>        }<a name="line.78"></a>
<FONT color="green">079</FONT>        this.sendAndQuit();<a name="line.79"></a>
<FONT color="green">080</FONT>        summaryInfo(startTime, "Code Issue", numberOfCodeIssues);<a name="line.80"></a>
<FONT color="green">081</FONT>      }<a name="line.81"></a>
<FONT color="green">082</FONT>    <a name="line.82"></a>
<FONT color="green">083</FONT>      /**<a name="line.83"></a>
<FONT color="green">084</FONT>       * Parses a PMD XML file and sends the code issue instances to the shell.<a name="line.84"></a>
<FONT color="green">085</FONT>       * <a name="line.85"></a>
<FONT color="green">086</FONT>       * @param xmlFile The XML file name to be processed.<a name="line.86"></a>
<FONT color="green">087</FONT>       * @return The number of issues that have been processed in this XML file.<a name="line.87"></a>
<FONT color="green">088</FONT>       * @exception BuildException if any error.<a name="line.88"></a>
<FONT color="green">089</FONT>       */<a name="line.89"></a>
<FONT color="green">090</FONT>      public int processPmdXmlFile(File xmlFile) throws BuildException {<a name="line.90"></a>
<FONT color="green">091</FONT>        XMLGregorianCalendar runtimeGregorian = LongTimeConverter.convertLongToGregorian(this.runtime);<a name="line.91"></a>
<FONT color="green">092</FONT>    <a name="line.92"></a>
<FONT color="green">093</FONT>        try {<a name="line.93"></a>
<FONT color="green">094</FONT>          JAXBContext context = JAXBContext.newInstance(ObjectFactory.class);<a name="line.94"></a>
<FONT color="green">095</FONT>          Unmarshaller unmarshaller = context.createUnmarshaller();<a name="line.95"></a>
<FONT color="green">096</FONT>    <a name="line.96"></a>
<FONT color="green">097</FONT>          ArrayList&lt;File&gt; allSourceFiles = this.getSourceFiles();<a name="line.97"></a>
<FONT color="green">098</FONT>          Set&lt;String&gt; filesWithViolations = new HashSet&lt;String&gt;();<a name="line.98"></a>
<FONT color="green">099</FONT>    <a name="line.99"></a>
<FONT color="green">100</FONT>          Pmd pmdResults = (Pmd) unmarshaller.unmarshal(xmlFile);<a name="line.100"></a>
<FONT color="green">101</FONT>          List&lt;org.hackystat.sensor.ant.pmd.jaxb.File&gt; files = pmdResults.getFile();<a name="line.101"></a>
<FONT color="green">102</FONT>    <a name="line.102"></a>
<FONT color="green">103</FONT>          int codeIssueCount = 0;<a name="line.103"></a>
<FONT color="green">104</FONT>          verboseInfo("Processing information about files that had PMD issues.");<a name="line.104"></a>
<FONT color="green">105</FONT>          for (org.hackystat.sensor.ant.pmd.jaxb.File file : files) {<a name="line.105"></a>
<FONT color="green">106</FONT>            // Base unique timestamp off of the runtime (which is when it started running)<a name="line.106"></a>
<FONT color="green">107</FONT>            long uniqueTstamp = this.tstampSet.getUniqueTstamp(this.runtime);<a name="line.107"></a>
<FONT color="green">108</FONT>            // Get altered time as XMLGregorianCalendar<a name="line.108"></a>
<FONT color="green">109</FONT>            XMLGregorianCalendar uniqueTstampGregorian = LongTimeConverter<a name="line.109"></a>
<FONT color="green">110</FONT>                .convertLongToGregorian(uniqueTstamp);<a name="line.110"></a>
<FONT color="green">111</FONT>    <a name="line.111"></a>
<FONT color="green">112</FONT>            // derive the full path name from the file name<a name="line.112"></a>
<FONT color="green">113</FONT>            String fileName = file.getName();<a name="line.113"></a>
<FONT color="green">114</FONT>    <a name="line.114"></a>
<FONT color="green">115</FONT>            String fullFilePath = this.findSrcFile(allSourceFiles, fileName);<a name="line.115"></a>
<FONT color="green">116</FONT>            filesWithViolations.add(fullFilePath);<a name="line.116"></a>
<FONT color="green">117</FONT>    <a name="line.117"></a>
<FONT color="green">118</FONT>            Map&lt;String, String&gt; keyValMap = new HashMap&lt;String, String&gt;();<a name="line.118"></a>
<FONT color="green">119</FONT>            // Required<a name="line.119"></a>
<FONT color="green">120</FONT>            keyValMap.put("Tool", "PMD");<a name="line.120"></a>
<FONT color="green">121</FONT>            keyValMap.put("SensorDataType", "CodeIssue");<a name="line.121"></a>
<FONT color="green">122</FONT>            keyValMap.put("Timestamp", uniqueTstampGregorian.toString());<a name="line.122"></a>
<FONT color="green">123</FONT>            keyValMap.put("Runtime", runtimeGregorian.toString());<a name="line.123"></a>
<FONT color="green">124</FONT>            keyValMap.put("Resource", fullFilePath);<a name="line.124"></a>
<FONT color="green">125</FONT>    <a name="line.125"></a>
<FONT color="green">126</FONT>            HashMap&lt;String, Integer&gt; issueCounts = new HashMap&lt;String, Integer&gt;();<a name="line.126"></a>
<FONT color="green">127</FONT>    <a name="line.127"></a>
<FONT color="green">128</FONT>            List&lt;Violation&gt; violations = file.getViolation();<a name="line.128"></a>
<FONT color="green">129</FONT>            for (Violation violation : violations) {<a name="line.129"></a>
<FONT color="green">130</FONT>              String rule = violation.getRule();<a name="line.130"></a>
<FONT color="green">131</FONT>              String ruleset = violation.getRuleset();<a name="line.131"></a>
<FONT color="green">132</FONT>    <a name="line.132"></a>
<FONT color="green">133</FONT>              String key = ruleset + "_" + rule;<a name="line.133"></a>
<FONT color="green">134</FONT>              key = key.replaceAll(" ", ""); // remove spaces<a name="line.134"></a>
<FONT color="green">135</FONT>              if (issueCounts.containsKey(key)) {<a name="line.135"></a>
<FONT color="green">136</FONT>                Integer count = issueCounts.get(key);<a name="line.136"></a>
<FONT color="green">137</FONT>                issueCounts.put(key, ++count);<a name="line.137"></a>
<FONT color="green">138</FONT>              }<a name="line.138"></a>
<FONT color="green">139</FONT>              else {<a name="line.139"></a>
<FONT color="green">140</FONT>                // no previous mapping, add 1st issue to map<a name="line.140"></a>
<FONT color="green">141</FONT>                issueCounts.put(key, 1);<a name="line.141"></a>
<FONT color="green">142</FONT>              }<a name="line.142"></a>
<FONT color="green">143</FONT>            }<a name="line.143"></a>
<FONT color="green">144</FONT>            for (Entry&lt;String, Integer&gt; entry : issueCounts.entrySet()) {<a name="line.144"></a>
<FONT color="green">145</FONT>              String typeKey = TYPE + entry.getKey();<a name="line.145"></a>
<FONT color="green">146</FONT>              keyValMap.put(typeKey, entry.getValue().toString());<a name="line.146"></a>
<FONT color="green">147</FONT>            }<a name="line.147"></a>
<FONT color="green">148</FONT>    <a name="line.148"></a>
<FONT color="green">149</FONT>            this.sensorShell.add(keyValMap); // add data to sensorshell<a name="line.149"></a>
<FONT color="green">150</FONT>            codeIssueCount++;<a name="line.150"></a>
<FONT color="green">151</FONT>          }<a name="line.151"></a>
<FONT color="green">152</FONT>    <a name="line.152"></a>
<FONT color="green">153</FONT>          // process the zero issues<a name="line.153"></a>
<FONT color="green">154</FONT>          verboseInfo("Generating data for files that did not have PMD issues.");<a name="line.154"></a>
<FONT color="green">155</FONT>          for (File srcFile : getSourceFiles()) {<a name="line.155"></a>
<FONT color="green">156</FONT>            // Skip this entry if we've already processed it above. <a name="line.156"></a>
<FONT color="green">157</FONT>            if (filesWithViolations.contains(srcFile.getAbsolutePath())) {<a name="line.157"></a>
<FONT color="green">158</FONT>              continue;<a name="line.158"></a>
<FONT color="green">159</FONT>            }<a name="line.159"></a>
<FONT color="green">160</FONT>            // Alter startTime to guarantee uniqueness.<a name="line.160"></a>
<FONT color="green">161</FONT>            long uniqueTstamp = this.tstampSet.getUniqueTstamp(this.runtime);<a name="line.161"></a>
<FONT color="green">162</FONT>    <a name="line.162"></a>
<FONT color="green">163</FONT>            // Get altered time as XMLGregorianCalendar<a name="line.163"></a>
<FONT color="green">164</FONT>            XMLGregorianCalendar uniqueTstampGregorian = LongTimeConverter<a name="line.164"></a>
<FONT color="green">165</FONT>                .convertLongToGregorian(uniqueTstamp);<a name="line.165"></a>
<FONT color="green">166</FONT>    <a name="line.166"></a>
<FONT color="green">167</FONT>            Map&lt;String, String&gt; keyValMap = new HashMap&lt;String, String&gt;();<a name="line.167"></a>
<FONT color="green">168</FONT>            keyValMap.put("Tool", "PMD");<a name="line.168"></a>
<FONT color="green">169</FONT>            keyValMap.put("SensorDataType", "CodeIssue");<a name="line.169"></a>
<FONT color="green">170</FONT>            keyValMap.put("Timestamp", uniqueTstampGregorian.toString());<a name="line.170"></a>
<FONT color="green">171</FONT>            keyValMap.put("Runtime", runtimeGregorian.toString());<a name="line.171"></a>
<FONT color="green">172</FONT>            keyValMap.put("Resource", srcFile.getAbsolutePath());<a name="line.172"></a>
<FONT color="green">173</FONT>    <a name="line.173"></a>
<FONT color="green">174</FONT>            this.sensorShell.add(keyValMap); // add data to sensorshell<a name="line.174"></a>
<FONT color="green">175</FONT>            codeIssueCount++;<a name="line.175"></a>
<FONT color="green">176</FONT>          }<a name="line.176"></a>
<FONT color="green">177</FONT>    <a name="line.177"></a>
<FONT color="green">178</FONT>          return codeIssueCount;<a name="line.178"></a>
<FONT color="green">179</FONT>        }<a name="line.179"></a>
<FONT color="green">180</FONT>        catch (JAXBException e) {<a name="line.180"></a>
<FONT color="green">181</FONT>          throw new BuildException(errMsgPrefix + "Failure in JAXB " + xmlFile, e);<a name="line.181"></a>
<FONT color="green">182</FONT>        }<a name="line.182"></a>
<FONT color="green">183</FONT>        catch (SensorShellException f) {<a name="line.183"></a>
<FONT color="green">184</FONT>          throw new BuildException(errMsgPrefix + "Failure in SensorShell " + xmlFile, f);<a name="line.184"></a>
<FONT color="green">185</FONT>        }<a name="line.185"></a>
<FONT color="green">186</FONT>      }<a name="line.186"></a>
<FONT color="green">187</FONT>    <a name="line.187"></a>
<FONT color="green">188</FONT>      /**<a name="line.188"></a>
<FONT color="green">189</FONT>       * Finds the full file path of the source path within the src files collection. For example,<a name="line.189"></a>
<FONT color="green">190</FONT>       * srcFiles could contain: [c:\foo\src\org\Foo.java, c:\foo\src\org\Bar.java] and the sourcePath<a name="line.190"></a>
<FONT color="green">191</FONT>       * could be org\Foo.java. This method will find and return the full path of the Foo.java file.<a name="line.191"></a>
<FONT color="green">192</FONT>       * <a name="line.192"></a>
<FONT color="green">193</FONT>       * @param srcFiles Contains the full path to the files.<a name="line.193"></a>
<FONT color="green">194</FONT>       * @param sourcePath Contains a trimmed version of a file path.<a name="line.194"></a>
<FONT color="green">195</FONT>       * @return The full file path, or null if the path is not found.<a name="line.195"></a>
<FONT color="green">196</FONT>       */<a name="line.196"></a>
<FONT color="green">197</FONT>      private String findSrcFile(List&lt;File&gt; srcFiles, String sourcePath) {<a name="line.197"></a>
<FONT color="green">198</FONT>        for (File srcFile : srcFiles) {<a name="line.198"></a>
<FONT color="green">199</FONT>          if (srcFile == null) {<a name="line.199"></a>
<FONT color="green">200</FONT>            continue;<a name="line.200"></a>
<FONT color="green">201</FONT>          }<a name="line.201"></a>
<FONT color="green">202</FONT>          String srcFilePath = srcFile.getAbsolutePath();<a name="line.202"></a>
<FONT color="green">203</FONT>          String alteredSourcePath = sourcePath;<a name="line.203"></a>
<FONT color="green">204</FONT>          if (srcFilePath.contains("\\")) {<a name="line.204"></a>
<FONT color="green">205</FONT>            alteredSourcePath = sourcePath.replace('/', '\\');<a name="line.205"></a>
<FONT color="green">206</FONT>          }<a name="line.206"></a>
<FONT color="green">207</FONT>          if (srcFile != null &amp;&amp; srcFilePath.contains(alteredSourcePath)) {<a name="line.207"></a>
<FONT color="green">208</FONT>            return srcFilePath;<a name="line.208"></a>
<FONT color="green">209</FONT>          }<a name="line.209"></a>
<FONT color="green">210</FONT>        }<a name="line.210"></a>
<FONT color="green">211</FONT>        return null;<a name="line.211"></a>
<FONT color="green">212</FONT>      }<a name="line.212"></a>
<FONT color="green">213</FONT>    }<a name="line.213"></a>




























































</PRE>
</BODY>
</HTML>
